CAS Configuration File Keywords

Services > Service Configuration Files > Service Configuration File Keywords > CAS Configuration File Keywords

CAS Configuration File Keywords

For more information about modifying the CAS configuration file, see Service Configuration Files.

The CAS keywords are listed in the tables below:

Service Info Keywords
Associated Services Keywords
Security Keywords
Replication Keywords
Backup Keywords
Auditing Keywords
Other Keywords
Logging Keywords

Note: An asterisk in the Options column ( * ) denotes a user-defined option.

Service Info Keywords

Keyword	Required	Description	Default	Options
SERVICE	Yes	The name of the service in Site.Service format.	None	8 chars max each for site and service name; no spaces; must be unique to the system. Valid characters are: A-Z, 0-9, !, $, _
SVC_PORT	Yes	The UDP port number for this service. Each service on the computer must have a unique port number. Use the Config File Manager to ensure that all ports for all services on a given server are unique.	6008	5001 to 32767 (5410 can be used only by the ARS)
REDUNDANT	No	Indicates whether Redundancy is enabled for this service and it is part of a redundant set with other services. Set to TRUE to enable Redundancy for this service and indicate that it is in a redundant relationship with another service within the redundancy environment. Set to FALSE or commented out to disable Redundancy for this service. See Redundancy for more configuration details. A redundancy definition for your CygNet environment is configured in the CygNet Redundancy Editor. Note: A redundant RSM cannot be managed by another RSM in your redundancy environment. CygNet won’t allow an RSM to start an owned RSM if that RSM has the REDUNDANT keyword set to TRUE. The IN_REDUNDANT_SET (Service in redundant set) info item will report whether this service is part of a redundant relationship.	FALSE	TRUE, FALSE

Keyword

Required

Description

Default

Options

SERVICE

Yes

The name of the service in Site.Service format.

None

8 chars max each for site and service name; no spaces; must be unique to the system.

Valid characters are:

A-Z, 0-9, !, $, _

SVC_PORT

Yes

The UDP port number for this service. Each service on the computer must have a unique port number. Use the Config File Manager to ensure that all ports for all services on a given server are unique.

6008

5001 to 32767

(5410 can be used only by the ARS)

REDUNDANT

Indicates whether Redundancy is enabled for this service and it is part of a redundant set with other services.

Set to TRUE to enable Redundancy for this service and indicate that it is in a redundant relationship with another service within the redundancy environment.
Set to FALSE or commented out to disable Redundancy for this service.

See Redundancy for more configuration details. A redundancy definition for your CygNet environment is configured in the CygNet Redundancy Editor.

Note: A redundant RSM cannot be managed by another RSM in your redundancy environment. CygNet won’t allow an RSM to start an owned RSM if that RSM has the REDUNDANT keyword set to TRUE.

The IN_REDUNDANT_SET (Service in redundant set) info item will report whether this service is part of a redundant relationship.

FALSE

TRUE, FALSE

Associated Services Keywords

Keyword	Required	Description	Default	Options
ELS	Yes	The Site and Service name of the service’s ELS, in Site.Service format.	SITE.ELS	Any valid service name of the corresponding type.
MSS	Yes	The Site and Service name of the MSS service from which commands will be accepted, in Site.Service format.	SITE.MSS
ALARM_HISTORY_SVC	Yes	The name of the service to report alarm history. CygNet name of the alarm history service (ELS).	Any ELS or ELSALM.
ACS	Yes	The Site and Service name of the service’s ACS, in Site.Service format.	SITE.ACS
AUD	No	The Site and Service name of the service’s AUD, in Site.Service format.	SITE.AUD

Security Keywords

Keyword	Required	Description	Default	Options
ACS_APPLICATION	Yes	The service’s application name for security.	CAS	Any valid security application ID
ACS_ID	Yes	The User ID of the service. This keyword is required for performing security events.	CAS	*

Replication Keywords

Keyword	Required	Description	Default	Options
CHANGE_QUEUE_SIZE	No	Sets the size of the service change queue that contains the incremental changes to the data in the source service. This is the number of changes the service will store to answer replication requests before expiring the oldest changes. Notes: This keyword is initially commented out by default. Uncomment the line and enter a valid value to use anything other than the default value. If 0 is specified, the change notification is disabled. This keyword is specified in the configuration file for the source service. The CHANGE_QUEUE_SIZE (Change Update Queue Size) info item will report configured size of the service change queue.	5000	*
REPL_SOURCE	No	Specifies the Domain and Site.Service name for the source service to be replicated. If not specified, replication is disabled. Applies to all services except ARS, FMS, and RSM. Note: This keyword is specified in the configuration file for the replicated (destination) service. The REPL_SOURCE (Repl Source Service) info item will report the source service name from which the replicated service is requesting changes. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.	None	[DDDD]SITE.SERVICE
REPL_CHECK_INTERVAL	No	Indicates the interval (in seconds) to check before performing the next replication synchronization. This value determines the replication synchronization frequency. After performing a sync, a replicating service will subtract the amount of time the sync took from the check interval time to determine how long to wait until the next sync. For example, if the check interval is 60 seconds and the sync takes 40 seconds, the service will only wait 20 seconds before starting the next sync. If the whole sync time exceeds the frequency, then the replicating service will wait for half the sync interval (30 seconds in this case) before starting the next sync. Note: This keyword is specified in the configuration file for the replicated (destination) service. The REPL_CHECK_INTERVAL (Repl Poll Secs) info item will report the interval that a replicated service will check the source change queue for new updates. If the service is not replicating REPL_CHECK_INTERVAL will respond with an empty string.	2	1 to 3600
REPL_DELAY_MAX	No	Indicates the number of seconds a service is allowed to be behind in replication before it is considered to be behind. If this keyword is disabled, the value defaults to double the REPL_CHECK_INTERVAL time. Best practice recommends enabling and setting a meaningful value for REPL_DELAY_MAX for all replicating services. A recommended value would be a longer time interval than you would expect any sync interval to take. Note: This keyword is specified in the configuration file for the replicated service. The REPL_DELAY_MAX (Allowed repl delay) info item will report the time elapsed since the service was last fully in sync. Time is calculated as the delta between "now" and the end of the last full sync that has completed. If the time since the last successful sync exceeds the REPL_DELAY_MAX value, and the REPL_INT_VAL_STATE (Int repl val state) info item is currently "Normal", then the REPL_INT_VAL_STATE info item is set to "Delayed." The state can only be set back to "Normal" when the time between two syncs is less than the REPL_DELAY_MAX time.	120	1 to 3600
REPL_FORWARD_DIRECTORY	No	If the service is in replication mode and this keyword is defined, then a setpoint command issued to the source service will be written out as an XML file (ForwardCmds_CVS_Site.Service_######.xml) and saved in the specified directory. Note that setting this keyword does not write the value to the source service. The user will need to evaluate the command and decide whether to modify a point’s current value using a setpoint command on the source service. If this keyword is empty or commented out, then Replication Command Forwarding is disabled. See Replication Command Forwarding for more information.	None
REPL_FORWARD_MAX_FILES	No	The maximum number of files in the directory specified by the keyword REPL_FORWARD_DIRECTORY. Once this number is reached, the service will attempt to begin deleting the oldest files. Must be in the range 10-1000. See Replication Command Forwarding for more information.	50	10 to 1000

Backup Keywords

Keyword	Required	Description	Default	Options
BACKUP_PATH	No	Specifies the path to the backup directory for the service files. The path can be relative or absolute. If the path contains spaces it must be enclosed in quotation marks. The service will create the backup folder if it does not exist. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.	None	* (path)
BACKUP_TIME	No	Specifies the time for the daily backup to run (24-hour format 0000 to 2359, do not use a colon). If this keyword is not enabled for a service or no time is specified, the automatic backup will not occur. Service backup will only occur if manually initiated or scheduled via the MSS. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.	None	0000 to 2359
COPY_BACKUP_TO	No	Enables copying of the backup service files to the specified directory once the backup process is complete. The path can be relative or absolute. If the directory does not exist the service will create it. If the path or directory name contains spaces, the parameter must be enclosed in quotation marks. If you specify a network drive and are running the CygNet services as system services, you must use the Universal Naming Convention (UNC) (\\Workstation\Path) to specify the path. The backup file can be copied to a network drive only if the drive is mapped to the local machine. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.	None	* (path)

Keyword

Required

Description

Default

Options

BACKUP_PATH

Specifies the path to the backup directory for the service files. The path can be relative or absolute. If the path contains spaces it must be enclosed in quotation marks. The service will create the backup folder if it does not exist. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

* (path)

BACKUP_TIME

Specifies the time for the daily backup to run (24-hour format 0000 to 2359, do not use a colon). If this keyword is not enabled for a service or no time is specified, the automatic backup will not occur. Service backup will only occur if manually initiated or scheduled via the MSS. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

0000 to 2359

COPY_BACKUP_TO

Enables copying of the backup service files to the specified directory once the backup process is complete. The path can be relative or absolute. If the directory does not exist the service will create it. If the path or directory name contains spaces, the parameter must be enclosed in quotation marks. If you specify a network drive and are running the CygNet services as system services, you must use the Universal Naming Convention (UNC) (\\Workstation\Path) to specify the path. The backup file can be copied to a network drive only if the drive is mapped to the local machine. Use the Config File Manager to automatically configure this keyword for all services in your CygNet environment.

None

* (path)

Auditing Keywords

Both CAS auditing keyword parameters must be set to "1" for any auditing to occur. See CAS Audit Levels for more information.

Keyword	Required	Description	Default	Options
AUDIT_LEVEL	No	Sets auditing level of messages written to the AUD service. When set to 0, auditing is off.	1	0, 1
AUDIT_LEVEL_METADATA	No	Sets the audit level for user modifications to any CygNet metadata for this service. When set to 0, auditing is off.	1	0, 1

Other Keywords

Keyword	Required	Description	Default	Options
PRINTER_PORT	No	COM port where line printer is connected.	None	COM#
PRINTER_SPEED	No	Printer baud rate.	9600	300 to 9600
PERSIST_FILE_REFRESH_RATE	No	Specifies the rate (in minutes) at which to write current persisted values to the CasPersist.dat file.	10	1 to 1440

Logging Keywords

Keyword	Required	Description	Default	Options
LOGMASK_ELS	Yes	Specifies the types of service events to be logged to the associated ELS (specified in the ELS keyword). To disable logging to the ELS, comment out the ELS keyword for the selected service. See the Note below this table for more information about the keyword values. See LOGMASK_ELS in the Logging section of this Help for more information. The LOGMASK_ELS ( LMask ELS) info item will report the value of this keyword.	CONTROL EXCEPTIONS	LOG_ALL or any combination of: CONTROL EXCEPTIONS WARNING PROG_STAT MIN_TRACE
LOGMASK_FILE	Yes	Specifies the type(s) of service events to be logged to the service’s log file ([file name].log). During the current session of the service, data is written to the current log file. Log file names follow the naming convention of the selected logging mode (as set by the LOGFILE_MODE keyword value). See the Note below this table for more information about the keyword values. See LOGMASK_FILE in the Logging section of this Help for more information. The LOGMASK_FILE (LMask File) info item will report the value of this keyword.	CONTROL EXCEPTIONS WARNING PROG_STAT	LOG_ALL or any combination of: CONTROL EXCEPTIONS WARNING PROG_STAT MIN_TRACE MAX_TRACE ENTER_EXIT
LOGFILE_FILE_COUNT	Yes	Specifies the maximum number of log files that a service will create before it starts re-using log files. For example, a count of two will produce SVC001.log, then SVC002.log, and then start back at SVC001.log, where SVC is the name of the service. Specify any value from 2 to 100. See LOGFILE_FILE_COUNT in the Logging section of this Help for more information. The LOGFILE_FILE_COUNT (File Cnt) info item will report the value of this keyword.	2	2 to 100
LOGFILE_LINE_COUNT	Yes	When the value of the LOGFILE_LIMIT_MODE keyword is LINE, this keyword specifies the maximum number of lines per log file. When the specified line count is reached, the log file is truncated at the limit point, and logging is resumed using the next available log file. Specify any value from 1000 to 1000000. See LOGFILE_LINE_COUNT in the Logging section of this Help for more information. The LOGFILE_LINE_COUNT (Line Cnt) info item will report the value of this keyword.	1000000	1000 to 1000000
LOGFILE_MODE	Yes	Specifies the operational mode for the log file, that is, how log files are maintained. Options are LEGACY or EXTENDED. The default value is LEGACY. See LOGFILE_MODE in the Logging section of this Help for more information. The LOGFILE_MODE (Logging Mode) info item will report the value of this keyword.	LEGACY	EXTENDED LEGACY
LOGFILE_LIMIT_MODE	Yes	Specifies how to limit the size of each individual log file. Options are LINE (maximum line count is determined by the LOGFILE_LINE_COUNT keyword) or SIZE (maximum file size in megabytes) determined by the LOGFILE_FILE_SIZE keyword). The default value is LINE. See LOGFILE_LIMIT_MODE in the Logging section of this Help for more information. The LOGFILE_LIMIT_MODE (Limit Mode) info item will report the value of this keyword.	LINE	LINE SIZE
LOGFILE_FILE_SIZE	Yes	When the value of the LOGFILE_LIMIT_MODE keyword is set to SIZE, this keyword specifies the maximum size (in megabytes) allowed for a log file, before logging will be continued using the next log file. Possible maximum size values are user-determined, respecting the limits of your specific system configuration. The default value is 100 megabytes. When the specified limit is reached, the log finishes the current line, closes the current file, and then continues logging in the next available log file. See LOGFILE_FILE_SIZE in the Logging section of this Help for more information. The LOGFILE_FILE_SIZE (File Size) info item will report the value of this keyword.	100 megabytes	Depends on user system configuration

Note: Use the following keyword values to set logging options for the LOGMASK_ keywords.

LOG_ALL - logs all options. This is the highest level of logging and will log everything the service is programmed to log.
CONTROL - logs control operations, such as startups, shutdowns and UIS operational events, etc.
ENTER_EXIT - logs every entry and exit through functions. This is used primarily by a programmer to debug code, and is too verbose for the ELS (not applicable for LOGMASK_ELS).
EXCEPTIONS - logs all exceptions thrown, not all of which are severe. An exception is an unexpected event occurring during execution of the service. It could be the result of a configuration error, an invalid command parameter, a bug, etc.
MAX_TRACE - more verbose logging than MIN_TRACE. This is used primarily by a programmer to debug code, and is too verbose for the ELS (not applicable for LOGMASK_ELS).
MIN_TRACE - used primarily by a programmer to debug code.
PROG_STAT - typically used to monitor the progress of the code through some logical steps. Some services, like the GNS, use it to add to the logging of the notifications, acknowledgments, and operations.
STATISTICS - enables gathering and reporting of message processing statistics.
WARNING - logs anomalies, not as serious as exceptions.

Example

A value for LOGMASK_ELS might be CONTROL + EXCEPTIONS.

A value for LOGMASK_FILE might be CONTROL + EXCEPTIONS + WARNING + PROG_STAT.